home *** CD-ROM | disk | FTP | other *** search
/ Aminet 3 / Aminet 3 - July 1994.iso / Aminet / util / misc / DOSPrefs11.lha / DOSPrefs.doc < prev    next >
Encoding:
Text File  |  1994-03-10  |  8.9 KB  |  268 lines
  1. 1. About DOSPrefs
  2.  
  3. DOSPrefs is a small commodity with three functions:
  4.  
  5. 1. Control the "Wildstar"-flag of the Amiga OS 2.0+ dos.library.
  6.  
  7. 2. Control the "Noclick"-flags of the Amiga OS 2.0+ trackdisk.device.
  8.  
  9. 3. Provide an all new "Unixdirs"-feature.
  10.  
  11. These functions can be controlled when DOSPrefs is started by Tooltypes,
  12. or at runtime by Intuition(tm)-menus.
  13.  
  14. Furthermore, DOSPrefs is localized, using the locale.library* (requiring
  15. Workbench 2.1+) to adapt to your prefered language, and provides a context-
  16. sensitive help system with AmigaGuide(tm) (requiring amigaguide.library V34+).
  17. (Simply press "Help" !)
  18.  
  19. * currently, catalog and amigaguide help files for the following languages
  20. are included:
  21.  
  22. english (catalog built in)
  23. deutsch
  24.  
  25. If you want, you can help me to provide support for additional languages.
  26. All you have to do is fill in the empty catalog source file DOSPrefs.ct and
  27. translate the helpfile catalogs/english/DOSPrefs.guide (note: you must not
  28. translate the @node names !!), and mail them to me (see below for my
  29. addresses). I will include them in the next release.
  30.  
  31. 2. Requirements
  32.  
  33. DOSPrefs requires at least Kickstart 2.04. To be more exact, the following
  34. libraries are needed:
  35.  
  36. exec.library V37
  37. dos.library V37
  38. commodities.library V37
  39. icon.library V37
  40. utility.library V37
  41. intuition.library V37
  42. gadtools.library V37
  43. graphics.library V37
  44. locale.library V38*
  45. amigaguide.library V34*
  46.  
  47. *: optional
  48.  
  49. 3. Installation
  50.  
  51. If you have the C= Installer program, simply double-click on the 
  52. Install-DOSPref Icon to start the installation. If you do not have the
  53. installer, this is what you have to do:
  54.  
  55. copy DOSPrefs SYS:WBStartup clone
  56. copy DOSPrefs.info SYS:WBStartup clone
  57. copy catalogs LOCALE:catalogs all clone ; if you have WB 2.1 +
  58. copy help HELP: all clone               ; if you have amigaguide
  59.  
  60. You may of course opt to install catalogs and helpfiles for only some of the
  61. provided languages.
  62.  
  63. NOTE: If you have AmigaGuide, DOSPrefs needs a HELP: assign. The standard
  64. for this assign is the directory locale:help. 
  65.  
  66. 4. Tooltypes
  67.  
  68. When DOSPrefs is started from the Workbench(tm), it evaluates the tooltypes
  69. of its icon; when it is started from the CLI, it evaluates the commandline
  70. arguments (the recognized Parameters are in both cases the same). The 
  71. parameters recognized by DOSPrefs are summarized in the following template:
  72.  
  73. CX_PRIORITY/N/K,CX_POPKEY/K,CX_POPUP/K,PUBSCREEN/K,WILDSTAR/K,UNIXDIRS/K,
  74. NOCLICK/K
  75.  
  76. CX_PRIORITY (default: 0): This is the priority for the commodities event
  77. handling mechanism.
  78.  
  79. CX_POPKEY (default: lalt d): This is the hotkey that causes DOSPrefs to
  80. show its interface. (By the way: starting DOSPrefs a second time will have
  81. the same effect as pressing the hot key; the first DOSPrefs will pop up and
  82. the second will terminate immediately.)
  83.  
  84. CX_POPUP (default: yes): This determines, if DOSPrefs is to show its
  85. interface on program startup.
  86.  
  87. PUBSCREEN (no default): This is the name of the public screen on which
  88. DOSPrefs is to open its interface. If this parameter is not specified or
  89. the given screen cannot be found, DOSPrefs opens its interface on the
  90. default public screen.
  91.  
  92. WILDSTAR (default: yes): This determines, if DOSPrefs is to set the
  93. wildstar flag of the dos.library on startup.
  94.  
  95. UNIXDIRS (default: yes): This determines, if DOSPrefs is to install the
  96. unixdirs-patch on startup.
  97.  
  98. NOCLICK (no default): This determines, for which floppy drives DOSPrefs
  99. sets the noclick-flags on startup. You have to list the
  100. drives seperated by "|"s, e.g. "DF1:", "DF0:|DF1:|DF2:".
  101.  
  102. CAUTION: If an empty drive clicks even if you have set the noclick flag
  103. for this drive, unset the flag immediately. Your disk drive may be damaged
  104. otherwise.
  105.  
  106. 5. Menus
  107.  
  108. DOSPrefs has the following Menu-structure (using the english language):
  109.  
  110.    Project              Settings
  111.      Enable               WildStar
  112.      Disable              UnixDirs
  113.      Hide                 NoClick
  114.      About                  DF0:
  115.      Quit                   DF1:
  116.                             DF2:
  117.                             DF3:
  118.  
  119.  
  120. 5.1 The Project Menu
  121.  
  122. "Enable" brings DOSPrefs to the active state. If it is already active,
  123. the "Enable" item is ghosted.
  124.  
  125. "Disable" brings DOSPrefs to the inactive state, if possible. If it is
  126. already inactive, the "Disable" item is ghosted.
  127. This operation may fail if the "unixdirs"-patch cannot be undone.
  128.  
  129. "Hide" hides the user interface of DOSPrefs. (Clicking on the
  130. closegadget has the same effect.) To make the interface visible again,
  131. press the hot key or use the commodities exchange program.
  132.  
  133. "About" shows a nice, short copyright message. ;-)
  134.  
  135. "Quit" terminates DOSPrefs, if possible.
  136. This may fail if the "unixdirs"-patch cannot be undone.
  137.  
  138. 5.2 The Settings Menu
  139.  
  140. 5.2.1 The WildStar Item
  141.  
  142. "WildStar" toggles the wildstar-flag of the dos.library. If the flag is set,
  143. "*" will be recognized as an abbreviation for "#?" in search patterns.
  144.  
  145. 5.2.2 The UnixDirs Item
  146.  
  147. "UnixDirs" enables the unixdirs-patch of the dos.library. What does this
  148. patch do ? It allows the use of the special directory names ".." and "."
  149. like under UNIX (thus the name of the function).
  150.  
  151. ".." represents the parent-directory of the current directory (like "/").
  152. So "../blabla" is identical to "/blabla", etc.
  153.  
  154. "." is the current directory. Thus you can say "copy ../blabla/*.c .".
  155.  
  156. NOTE: Due to the nature of library patches, it may not be possible to
  157. unpatch the dos.library, because a) the patched functions are in use or b)
  158. someone has patched again some of the patched functions after DOSPrefs. 
  159. DOSPrefs will detect these conditions and put up a requester allowing you to 
  160. try again to unpatch the dos.library or canceling the operation.
  161.  
  162. Here is an alphabetic list of the patched library funtions:
  163.  
  164. AssignLate
  165. AssignPath
  166. CreateDir
  167. DeleteFile
  168. GetDeviceProc
  169. LoadSeg
  170. Lock
  171. MakeLink
  172. NewLoadSeg
  173. Open
  174. Rename
  175. SetComment
  176. SetFileDate
  177. SetOwner*
  178. SetProtection
  179.  
  180. * V39 dos.library funtion
  181.  
  182. NOTE: In version 1.0, DOSPrefs patched some more functions. This was not a
  183. good idea - it could caused weird problems when I improved the string
  184. conversion routine. 
  185.  
  186. 5.2.3 The NoClick SubMenu
  187.  
  188. The "NoClick" item has four subitems labeled "DF0:" to "DF3:", that allow you
  189. to set the noclick-flag individually for each of your disk drives. If a disk
  190. drive does not exist, its subitem is disabled.
  191.  
  192. CAUTION: If an empty drive clicks even if you have set the noclick flag
  193. for this drive, unset the flag immediately. Your disk drive may be damaged
  194. otherwise.
  195.  
  196. 6. Licence
  197.  
  198. DOSPrefs is Freeware. You may freely redistribute the complete, unchanged
  199. archive. You may not change any of the files or distribute an incomplete
  200. version of the archive. (Of course, you may change ToolTypes in the .info
  201. files. :-)) You may not add files to the archive, except ony .displayme -
  202. file with your mailbox-logo if - and only if - you have the archive freely
  203. available for download.
  204.  
  205. You may charge no more than DM 5,- (or US $3) for a disk containing DOSPrefs. 
  206. (Fred Fish is exempt from this rule.) DOSPrefs may also be distributed on
  207. CD-ROM (if the price is below US $50). 
  208.  
  209. 7. Disclaimer & Warranty
  210.  
  211.      THERE IS NO WARRANTY FOR THE PROGRAMS, TO THE EXTENT PERMITTED
  212.      BY APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE
  213.      COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAMS "AS
  214.      IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
  215.      INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  216.      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE
  217.      ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAMS IS
  218.      WITH YOU.  SHOULD THE PROGRAMS PROVE DEFECTIVE, YOU ASSUME THE
  219.      COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.  
  220.  
  221.        IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
  222.      WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
  223.      REDISTRIBUTE THE PROGRAMS AS PERMITTED ABOVE, BE LIABLE TO YOU
  224.      FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
  225.      CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
  226.      THE PROGRAMS (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
  227.      BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
  228.      PARTIES OR A FAILURE OF THE PROGRAMS TO OPERATE WITH ANY OTHER
  229.      PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED
  230.      OF THE POSSIBILITY OF SUCH DAMAGES.  
  231.  
  232. There is no warranty at all. Use at your own risk.
  233.  
  234. 8. Bug Reports
  235.  
  236. Report bugs & improvement suggestions to:
  237.  
  238. SnailMail:
  239.   Norbert Püschel
  240.   Am Turm 6
  241.   53572 Unkel
  242.   Germany
  243.  
  244. or
  245.  
  246. EMail:
  247.   nobbi@zaphod.rhein.de (Internet)
  248.  
  249.   2:2453/30.14  (FidoNet)
  250.   21:100/50.14  (GerNet)
  251.   53:228/107.14 (BonNet)
  252.  
  253. 9. Credits
  254.  
  255. Thanks to the TrapDoor-Team for the disclaimer I shamelessly copied from
  256. them. ;-)
  257.  
  258. 10. Version History
  259.  
  260.   1.0 (.07.93)
  261.   - first public release
  262.  
  263.   1.1 (.03.94)
  264.   - reduced number of patched functions. Some patches were superfluous,
  265.     some even potentially dangerous.
  266.   - improved string conversion routine. Now, the strings are no longer
  267.     patched "in place" but copied & converted onto the stack.
  268.